<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>console.example</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="console-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/console/">console</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="console-module.html">Package&nbsp;console</a> ::
        Module&nbsp;example
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="console.example-pysrc.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="console.example-module.html">Module console.example</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno">  1</tt>  <tt class="py-line"><tt class="py-comment">#!/usr/bin/env python</tt> </tt>
<a name="L2"></a><tt class="py-lineno">  2</tt>  <tt class="py-line"> </tt>
<a name="L3"></a><tt class="py-lineno">  3</tt>  <tt class="py-line"><tt class="py-comment"># console.example</tt> </tt>
<a name="L4"></a><tt class="py-lineno">  4</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L5"></a><tt class="py-lineno">  5</tt>  <tt class="py-line"><tt class="py-comment"># Copyright (C) 2010 Tactical Network Solutions</tt> </tt>
<a name="L6"></a><tt class="py-lineno">  6</tt>  <tt class="py-line"><tt class="py-comment"># Author: Benjamin Bengfort &lt;bbengfort@tacnetsol.com&gt;</tt> </tt>
<a name="L7"></a><tt class="py-lineno">  7</tt>  <tt class="py-line"><tt class="py-comment"># URL: &lt;http://tacnetsol.com&gt;</tt> </tt>
<a name="L8"></a><tt class="py-lineno">  8</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L9"></a><tt class="py-lineno">  9</tt>  <tt class="py-line"><tt class="py-comment"># $Id: example.py 2 2010-11-29 13:48:00 -0400 bbengfort $</tt> </tt>
<a name="L10"></a><tt class="py-lineno"> 10</tt>  <tt class="py-line"> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt>  <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt>  <tt class="py-line"><tt class="py-docstring">Example of using the console framework.</tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt>  <tt class="py-line"><tt class="py-docstring">Overview</tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt>  <tt class="py-line"><tt class="py-docstring">========</tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt>  <tt class="py-line"><tt class="py-docstring">This code represents a standard methodology for programming console programs</tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt>  <tt class="py-line"><tt class="py-docstring">using the L{console} framework. Essentially, external functionality is imported</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt>  <tt class="py-line"><tt class="py-docstring">from other modules, and commands are entry points to that functionality. Extend</tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt>  <tt class="py-line"><tt class="py-docstring">the L{InteractiveShell} and add custom commands either as internal private</tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt>  <tt class="py-line"><tt class="py-docstring">classes, or as their own class hierarchy, and then add them during</tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt>  <tt class="py-line"><tt class="py-docstring">L{CustomShell.__init__}.</tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt>  <tt class="py-line"><tt class="py-docstring">Good luck, and good coding!</tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt>  <tt class="py-line"><tt class="py-docstring">Class Hierarchy</tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt>  <tt class="py-line"><tt class="py-docstring">===============</tt> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt>  <tt class="py-line"><tt class="py-docstring">G{classtree: CustomShell CustomShell._CustomCommand}</tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt>  <tt class="py-line"><tt class="py-docstring">@author: U{Benjamin Bengfort&lt;mailto:bbengfort@tacnetsol.com&gt;}</tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt>  <tt class="py-line"><tt class="py-docstring">@organization: Tactical Network Solutions</tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt>  <tt class="py-line"><tt class="py-docstring">@license: Open Source MIT License</tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt>  <tt class="py-line"><tt class="py-docstring">@copyright: S{copy} 2010 Tactical Network Solutions</tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt>  <tt class="py-line"><tt class="py-docstring">@requires: Python 2.6</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt>  <tt class="py-line"><tt class="py-docstring">@version: 1.0</tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt>  <tt class="py-line"><tt class="py-docstring">@change: I{example.py 2 2010-11-29 13:48:00 -0400 bbengfort}</tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt>  <tt class="py-line"><tt class="py-docstring">@since: 2010-11-29 17:20:39 -0400</tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt>  <tt class="py-line"><tt class="py-docstring">@todo: Create other examples folder</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt>  <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt>  <tt class="py-line"><tt class="py-name">__docformat__</tt> <tt class="py-op">=</tt> <tt class="py-string">'epytext en'</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt>  <tt class="py-line"> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt>  <tt class="py-line"><tt class="py-comment">###################################################################### </tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt>  <tt class="py-line"><tt class="py-comment">## Imports </tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt>  <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt>  <tt class="py-line"> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Module console.interactive=console.interactive-module.html"><a title="console.interactive" class="py-name" href="#" onclick="return doclink('link-0', 'interactive', 'link-0');">interactive</a></tt> <tt class="py-keyword">import</tt> <tt id="link-1" class="py-name" targets="Class console.interactive.InteractiveCommand=console.interactive.InteractiveCommand-class.html"><a title="console.interactive.InteractiveCommand" class="py-name" href="#" onclick="return doclink('link-1', 'InteractiveCommand', 'link-1');">InteractiveCommand</a></tt><tt class="py-op">,</tt> <tt id="link-2" class="py-name" targets="Class console.interactive.InteractiveShell=console.interactive.InteractiveShell-class.html"><a title="console.interactive.InteractiveShell" class="py-name" href="#" onclick="return doclink('link-2', 'InteractiveShell', 'link-2');">InteractiveShell</a></tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt>  <tt class="py-line"> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt>  <tt class="py-line"><tt class="py-comment">###################################################################### </tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt>  <tt class="py-line"><tt class="py-comment">## Customized Shell</tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt>  <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt>  <tt class="py-line"> </tt>
<a name="CustomShell"></a><div id="CustomShell-def"><a name="L54"></a><tt class="py-lineno"> 54</tt> <a class="py-toggle" href="#" id="CustomShell-toggle" onclick="return toggle('CustomShell');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="console.example.CustomShell-class.html">CustomShell</a><tt class="py-op">(</tt><tt class="py-base-class">InteractiveShell</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="CustomShell-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="CustomShell-expanded"><a name="L55"></a><tt class="py-lineno"> 55</tt>  <tt class="py-line">     </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt>  <tt class="py-line">    <tt class="py-comment">###################################################################### </tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt>  <tt class="py-line">    <tt class="py-comment">## Custom commands (private) </tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt>  <tt class="py-line">    <tt class="py-comment">######################################################################</tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt>  <tt class="py-line">     </tt>
<a name="CustomShell._CustomCommand"></a><div id="CustomShell._CustomCommand-def"><a name="L60"></a><tt class="py-lineno"> 60</tt> <a class="py-toggle" href="#" id="CustomShell._CustomCommand-toggle" onclick="return toggle('CustomShell._CustomCommand');">-</a><tt class="py-line">    <tt class="py-keyword">class</tt> <a class="py-def-name" href="console.example.CustomShell._CustomCommand-class.html">_CustomCommand</a><tt class="py-op">(</tt><tt class="py-base-class">InteractiveCommand</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="CustomShell._CustomCommand-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="CustomShell._CustomCommand-expanded"><a name="L61"></a><tt class="py-lineno"> 61</tt>  <tt class="py-line">         </tt>
<a name="CustomShell._CustomCommand.get_name"></a><div id="CustomShell._CustomCommand.get_name-def"><a name="L62"></a><tt class="py-lineno"> 62</tt> <a class="py-toggle" href="#" id="CustomShell._CustomCommand.get_name-toggle" onclick="return toggle('CustomShell._CustomCommand.get_name');">-</a><tt class="py-line">        <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.example.CustomShell._CustomCommand-class.html#get_name">get_name</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="CustomShell._CustomCommand.get_name-collapsed" style="display:none;" pad="+++" indent="++++++++++++++++"></div><div id="CustomShell._CustomCommand.get_name-expanded"><a name="L63"></a><tt class="py-lineno"> 63</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-string">'custom'</tt> </tt>
</div><a name="L64"></a><tt class="py-lineno"> 64</tt>  <tt class="py-line"> </tt>
<a name="CustomShell._CustomCommand.get_options"></a><div id="CustomShell._CustomCommand.get_options-def"><a name="L65"></a><tt class="py-lineno"> 65</tt> <a class="py-toggle" href="#" id="CustomShell._CustomCommand.get_options-toggle" onclick="return toggle('CustomShell._CustomCommand.get_options');">-</a><tt class="py-line">        <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.example.CustomShell._CustomCommand-class.html#get_options">get_options</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="CustomShell._CustomCommand.get_options-collapsed" style="display:none;" pad="+++" indent="++++++++++++++++"></div><div id="CustomShell._CustomCommand.get_options-expanded"><a name="L66"></a><tt class="py-lineno"> 66</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-op">{</tt> <tt class="py-string">'opt'</tt><tt class="py-op">:</tt> <tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt>  <tt class="py-line">                     <tt class="py-string">'foo='</tt><tt class="py-op">:</tt> <tt class="py-string">'default'</tt><tt class="py-op">,</tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt>  <tt class="py-line">                     <tt class="py-string">'bar='</tt><tt class="py-op">:</tt> <tt class="py-name">None</tt><tt class="py-op">}</tt> </tt>
</div><a name="L69"></a><tt class="py-lineno"> 69</tt>  <tt class="py-line"> </tt>
<a name="CustomShell._CustomCommand.handle_command"></a><div id="CustomShell._CustomCommand.handle_command-def"><a name="L70"></a><tt class="py-lineno"> 70</tt> <a class="py-toggle" href="#" id="CustomShell._CustomCommand.handle_command-toggle" onclick="return toggle('CustomShell._CustomCommand.handle_command');">-</a><tt class="py-line">        <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.example.CustomShell._CustomCommand-class.html#handle_command">handle_command</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">opts</tt><tt class="py-op">,</tt> <tt class="py-param">args</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="CustomShell._CustomCommand.handle_command-collapsed" style="display:none;" pad="+++" indent="++++++++++++++++"></div><div id="CustomShell._CustomCommand.handle_command-expanded"><a name="L71"></a><tt class="py-lineno"> 71</tt>  <tt class="py-line"> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt>  <tt class="py-line">            <tt class="py-keyword">for</tt> <tt class="py-name">k</tt><tt class="py-op">,</tt><tt class="py-name">v</tt> <tt class="py-keyword">in</tt> <tt class="py-name">opts</tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt> <tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt>  <tt class="py-line">                <tt class="py-keyword">print</tt> <tt class="py-string">'%s =&gt; %s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">k</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">v</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt>  <tt class="py-line">             </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt>  <tt class="py-line">            <tt class="py-keyword">print</tt> <tt class="py-string">'Args is: %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">args</tt> </tt>
</div><a name="L76"></a><tt class="py-lineno"> 76</tt>  <tt class="py-line">             </tt>
<a name="CustomShell._CustomCommand.get_short_description"></a><div id="CustomShell._CustomCommand.get_short_description-def"><a name="L77"></a><tt class="py-lineno"> 77</tt> <a class="py-toggle" href="#" id="CustomShell._CustomCommand.get_short_description-toggle" onclick="return toggle('CustomShell._CustomCommand.get_short_description');">-</a><tt class="py-line">        <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.example.CustomShell._CustomCommand-class.html#get_short_description">get_short_description</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="CustomShell._CustomCommand.get_short_description-collapsed" style="display:none;" pad="+++" indent="++++++++++++++++"></div><div id="CustomShell._CustomCommand.get_short_description-expanded"><a name="L78"></a><tt class="py-lineno"> 78</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-string">'I am a custom command!'</tt> </tt>
</div><a name="L79"></a><tt class="py-lineno"> 79</tt>  <tt class="py-line"> </tt>
<a name="CustomShell._CustomCommand.get_help_message"></a><div id="CustomShell._CustomCommand.get_help_message-def"><a name="L80"></a><tt class="py-lineno"> 80</tt> <a class="py-toggle" href="#" id="CustomShell._CustomCommand.get_help_message-toggle" onclick="return toggle('CustomShell._CustomCommand.get_help_message');">-</a><tt class="py-line">        <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.example.CustomShell._CustomCommand-class.html#get_help_message">get_help_message</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="CustomShell._CustomCommand.get_help_message-collapsed" style="display:none;" pad="+++" indent="++++++++++++++++"></div><div id="CustomShell._CustomCommand.get_help_message-expanded"><a name="L81"></a><tt class="py-lineno"> 81</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-string">"""\</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt>  <tt class="py-line"><tt class="py-string">This custom command simply shows what the arguments do and don't do. It is very</tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt>  <tt class="py-line"><tt class="py-string">similar to the TestCommand, because it is the same exact thing.</tt> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt>  <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt>  <tt class="py-line"><tt class="py-string">Options:</tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt>  <tt class="py-line"><tt class="py-string">    --opt: A flag, set optionally</tt> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt>  <tt class="py-line"><tt class="py-string">    --foo: A settable option, not required, has a default value.</tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt>  <tt class="py-line"><tt class="py-string">    --bar: A settable option, required, no default value</tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt>  <tt class="py-line"><tt class="py-string">        """</tt> </tt>
</div></div><a name="L90"></a><tt class="py-lineno"> 90</tt>  <tt class="py-line">     </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt>  <tt class="py-line">    <tt class="py-comment">###################################################################### </tt> </tt>
<a name="L92"></a><tt class="py-lineno"> 92</tt>  <tt class="py-line">    <tt class="py-comment">## Overriden shell methods</tt> </tt>
<a name="L93"></a><tt class="py-lineno"> 93</tt>  <tt class="py-line">    <tt class="py-comment">######################################################################</tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</tt>  <tt class="py-line">     </tt>
<a name="CustomShell.__init__"></a><div id="CustomShell.__init__-def"><a name="L95"></a><tt class="py-lineno"> 95</tt> <a class="py-toggle" href="#" id="CustomShell.__init__-toggle" onclick="return toggle('CustomShell.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.example.CustomShell-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="CustomShell.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="CustomShell.__init__-expanded"><a name="L96"></a><tt class="py-lineno"> 96</tt>  <tt class="py-line">        <tt id="link-3" class="py-name"><a title="console.interactive.InteractiveShell" class="py-name" href="#" onclick="return doclink('link-3', 'InteractiveShell', 'link-2');">InteractiveShell</a></tt><tt class="py-op">.</tt><tt id="link-4" class="py-name" targets="Method console.example.CustomShell.__init__()=console.example.CustomShell-class.html#__init__,Method console.interactive.InteractiveShell._HelpCommand.__init__()=console.interactive.InteractiveShell._HelpCommand-class.html#__init__,Method console.interactive.InteractiveShell.__init__()=console.interactive.InteractiveShell-class.html#__init__"><a title="console.example.CustomShell.__init__
console.interactive.InteractiveShell._HelpCommand.__init__
console.interactive.InteractiveShell.__init__" class="py-name" href="#" onclick="return doclink('link-4', '__init__', 'link-4');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-string">'\nEasily convert metrics!'</tt><tt class="py-op">)</tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt>  <tt class="py-line">         </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt>  <tt class="py-line">        <tt class="py-name">customcmd</tt> <tt class="py-op">=</tt> <tt id="link-5" class="py-name" targets="Class console.example.CustomShell=console.example.CustomShell-class.html"><a title="console.example.CustomShell" class="py-name" href="#" onclick="return doclink('link-5', 'CustomShell', 'link-5');">CustomShell</a></tt><tt class="py-op">.</tt><tt id="link-6" class="py-name" targets="Class console.example.CustomShell._CustomCommand=console.example.CustomShell._CustomCommand-class.html"><a title="console.example.CustomShell._CustomCommand" class="py-name" href="#" onclick="return doclink('link-6', '_CustomCommand', 'link-6');">_CustomCommand</a></tt><tt class="py-op">(</tt> <tt class="py-op">)</tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-7" class="py-name" targets="Method console.interactive.InteractiveShell.add_command()=console.interactive.InteractiveShell-class.html#add_command"><a title="console.interactive.InteractiveShell.add_command" class="py-name" href="#" onclick="return doclink('link-7', 'add_command', 'link-7');">add_command</a></tt><tt class="py-op">(</tt><tt class="py-name">customcmd</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L100"></a><tt class="py-lineno">100</tt>  <tt class="py-line"> </tt>
<a name="L101"></a><tt class="py-lineno">101</tt>  <tt class="py-line"><tt class="py-keyword">if</tt>  <tt class="py-name">__name__</tt> <tt class="py-op">==</tt> <tt class="py-string">'__main__'</tt><tt class="py-op">:</tt> </tt>
<a name="L102"></a><tt class="py-lineno">102</tt>  <tt class="py-line">     </tt>
<a name="L103"></a><tt class="py-lineno">103</tt>  <tt class="py-line">    <tt class="py-name">console_program</tt> <tt class="py-op">=</tt> <tt id="link-8" class="py-name"><a title="console.example.CustomShell" class="py-name" href="#" onclick="return doclink('link-8', 'CustomShell', 'link-5');">CustomShell</a></tt><tt class="py-op">(</tt> <tt class="py-op">)</tt> </tt>
<a name="L104"></a><tt class="py-lineno">104</tt>  <tt class="py-line">    <tt class="py-name">console_program</tt><tt class="py-op">.</tt><tt id="link-9" class="py-name" targets="Method console.interactive.InteractiveShell.run()=console.interactive.InteractiveShell-class.html#run"><a title="console.interactive.InteractiveShell.run" class="py-name" href="#" onclick="return doclink('link-9', 'run', 'link-9');">run</a></tt><tt class="py-op">(</tt> <tt class="py-op">)</tt> </tt>
<a name="L105"></a><tt class="py-lineno">105</tt>  <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="console-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/console/">console</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Tue Nov 30 11:33:30 2010
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
